////////////////////////////////////////////////////////////////////////////////
// This file is part of the Mist compiler.                                    //
//                                                                            //
// Copyright (C) 2008, 2009 The Mist project                                  //
//                                                                            //
// For a list of contributors, see the COMMITTERS file.                       //
//                                                                            //
// The Mist compiler is free software: you can redistribute it and/or modify  //
// it under the terms of the GNU General Public License as published by       //
// the Free Software Foundation, either version 3 of the License, or          //
// (at your option) any later version.                                        //
//                                                                            //
// The Mist compiler is distributed in the hope that it will be useful,       //
// but WITHOUT ANY WARRANTY; without even the implied warranty of             //
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the              //
// GNU General Public License for more details.                               //
//                                                                            //
// You should have received a copy of the GNU General Public License          //
// in the COPYING file. If not, see <http://www.gnu.org/licenses/>.           //
////////////////////////////////////////////////////////////////////////////////

///
/// \file
/// Contains the DEFINE_EXCEPTION macro.
///

#ifndef EXCEPTION_HPP
#define EXCEPTION_HPP

////////////////////////////////////////////////////////////////////////////////
// Includes                                                                   //
////////////////////////////////////////////////////////////////////////////////

#include <exception>
using std::exception;

#include <string>
using std::string;

////////////////////////////////////////////////////////////////////////////////
// Exception Definition Macro                                                 //
////////////////////////////////////////////////////////////////////////////////

/// Define an exception type with name \a exceptionName and default message
/// \a defaultMessage. The resulting class has a constructor that optionally
/// takes the exception message, a what() function implementing the
/// std::exception interface and a message() function returning an std::string.
///
#define DEFINE_EXCEPTION(exceptionName, defaultMessage)                   \
	class exceptionName : public virtual exception {                      \
		public:                                                           \
			exceptionName(string what = defaultMessage) : _what(what) { } \
			                                                              \
			virtual ~exceptionName() throw() { }                          \
			                                                              \
			virtual const char* what() const throw() {                    \
				return _what.c_str();                                     \
			}                                                             \
			                                                              \
			virtual const string& message() const throw() {               \
				return _what;                                             \
			}                                                             \
		                                                                  \
		private:                                                          \
			                                                              \
			string _what;                                                 \
	};

#endif // EXCEPTION_HPP
